Workflow

CreateWorkflow

在Project下创建Workflow

请求语法

POST /accounts/<account_name>/projects/<project_name>/workflows/ HTTP/1.1

Header:

Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Region Endpoint>
Content-Length: <Content Length>
Content-Type: application/json
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

Body:
{
    "workflow_name": <WorkflowName>,
    "description": <DescriptionOfWorkflow>,
    "workflow_version": <WorkflowVersion>
}

请求参数

属性名称	类型	是否必须	描述
workflow_name	string	是	Workflow的名称，在project下必须唯一。3~128个字符，包含字母、数字、短横线”-“、下划线”_“，必须以字母开头。不支持中文Workflow名称。
description	string	否	对这个workflow的描述信息
workflow_version	int	是	默认第一个版本为1，后面版本自动加1

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

HTTP状态码返回200

错误码

除了返回GeneDock API的通用错误码，还可能返回如下特有错误码

HTTP状态码	错误码	错误信息	描述
400	InvalidParameter	Create workflow failed, since {reason}.	创建工作流失败，原因是{reason}。

请求示例

POST /accounts/genedock/projects/default/workflows/ HTTP/1.1

Header:

Authorization: GeneDock oHFcHbORoZCavj7GPtytUg==:4O4hJamy0fmGTRoMjt3itqTfNDc=
Date: Tur, 7 Apr 2016 02:04:34 GMT
Host: cn-shenzhen-api.genedock.com
Content-Length: 81
Content-Type: application/json
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

Body:
{
    "workflow_name": "BWA-MEM",
    "description": " ",
    "workflow_version": 1
}

响应示例

HTTP/1.1 200 OK

Header：

Date: Tur, 7 Apr 2016 02:04:34 GMT
Content-Length: 0
x-gd-requestid: 573c1981c3666e19ea024349
Connection: close
Server: nginx/1.4.6

PutWorkflow

修改工作流配置.

请求语法

PUT /accounts/<account_name>/projects/<project_name>/workflows/<workflow_name>/ HTTP/1.1

Header:

Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Region Endpoint>
Content-Length: <Content Length>
Content-Type: application/json
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

Body:
{
    "workflow_version": <WorkflowVersion>,
    "description": <WorkflowDescription>,
    "configs": <TemplateJson>
}

请求参数

属性名称	类型	是否必须	描述
workflow_version	int	是	指定workflow版本号
description	string	否	workflow描述信息。如果没有提供description参数，系统将不会修改workflow的描述信息。
configs	json	是	workflow配置模板

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

HTTP状态码返回200

错误码

除了返回GeneDock API的通用错误码，还可能返回如下特有错误码

HTTP状态码	错误码	错误信息	描述
400	InvalidParameter	Put workflow definition failed, since {reason}.	修改工作流配置失败，原因是{reason}。

细节描述

创建过程中遇到格式错误、必要参数遗失、或者quota超过限制等错误，则会创建失败。

请求示例

PUT /accounts/genedock/projects/default/workflows/BWA-MEM/ HTTP/1.1

Header:

Authorization: GeneDock oHFcHbORoZCavj7GPtytUg==:W/YLZT4bD7Wgkd9q5OMh2/+6Lwg=
Date: Tur, 7 Apr 2016 02:04:34 GMT
Host: cn-shenzhen-api.genedock.com
Content-Length: 2758
Content-Type: application/json
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

Body:
{
    "workflow_version": 1,
    "description": " ",
    "configs": {
        "nodelist": [
            {
                "alias": "bam",
                "node_id": "loaddataNode1",
                "app_id": "55128c58f6f4067d63b956b5",
                "name": "loaddata",
                "outputs": {
                    "data": {
                        "enid": "bam_enid"
                    }
                }
            },
            {
                "inputs": {
                    "bam": [
                        {
                            "enid": "bam_enid"
                        }
                    ]
                },
                "node_id": "samtools_stats_1_3_5_g664cc5fNode2",
                "name": "samtools stats 1.3-5-g664cc5f",
                "parameters": {
                    "filtering_flag": {
                        "variable": false,
                        "value": " "
                    },
                    "remove_dups": {
                        "variable": false,
                        "value": false
                    },
                    "required_flag": {
                        "variable": false,
                        "value": " "
                    }
                },
                "alias": "samtools stats",
                "outputs": {
                    "bc": [
                        {
                            "enid": "bc_enid"
                        }
                    ]
                },
                "app_id": "5722f7521315e0001397f2e3"
            },
            {
                "inputs": {
                    "bam_check": [
                        {
                            "enid": "bc_enid"
                        }
                    ]
                },
                "node_id": "plot_bamstatsNode3",
                "name": "plot-bamstats",
                "alias": "plot-bamstats",
                "outputs": {
                    "plot": [
                        {
                            "enid": "plot_bamstats_enid"
                        }
                    ]
                },
                "app_id": "5722febd1315e0001297f2eb"
            },
            {
                "inputs": {
                    "data": {
                        "enid": "plot_bamstats_enid"
                    }
                },
                "node_id": "storedataNode4",
                "name": "storedata",
                "parameters": {
                    "description": {
                        "variable": true,
                        "value": " "
                    },
                    "name": {
                        "variable": true,
                        "value": " "
                    }
                },
                "alias": "bc plot",
                "app_id": "55128c94f6f4067d63b956b6"
            }
        ]
    }
}

响应示例

HTTP/1.1 200 OK

Header：

Date: Tur, 7 Apr 2016 02:04:34 GMT
Content-Length: 0
x-gd-requestid: 573c1981c3666e19ea024349
Connection: close
Server: nginx/1.4.6

GetWorkflow

GetWorkflow接口返回当前project下指定的workflow信息。

请求语法

GET /accounts/<account_name>/projects/<project_name>/workflows/<workflow_name>/?workflow_version=<workflow_version> HTTP/1.1

Header:

Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Region Endpoint>
Content-Length: <Content Length>
Content-Type: application/json
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

请求参数

属性名称	类型	是否必须	描述
workflow_version	int	否	workflow的版本号。如果指定了workflow的版本，此API只会返回对应版本的workflow信息列表；如果没有指定workflow的版本，此API会返回所有版本的工作流信息列表。

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

若请求成功，HTTP状态码返回200，并且响应的Body中会返回指定workflow的信息列表。workflow信息的具体格式如下：

属性名称	类型	描述
version	int	workflow的版本号
description	string	workflow名的描述信息
status	string	workflow的状态，”unchecked”表示暂未添加workflow配置，”checked”表示已经添加了workflow配置
configs	json	workfow配置信息

错误码

除了返回GeneDock API的通用错误码，还可能返回如下特有错误码

HTTP状态码	错误码	错误信息	描述
400	InvalidParameter	Get workflow failed, since {reason}.	获取工作流失败，原因是{reason}。

请求示例

GET /accounts/genedock/projects/default/workflows/BWA-index/?workflow_version=3 HTTP/1.1

Header:

Authorization: GeneDock oHFcHbORoZCavj7GPtytUg==:pWsK9iuFUapeWXy3FC1bB6SbGGA=
Date: Thu, 01 Sep 2016 08:06:35 GMT
Host: cn-shenzhen-api.genedock.com
Content-Type: application/json; charset=UTF-8
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

响应示例

HTTP/1.1 200 OK

Header:

Server: nginx/1.1.19
Date: Thu, 01 Sep 2016 08:10:14 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 1250
Connection: keep-alive
x-gd-requestid: 57c7e26667185600207d82c2
Content-MD5: 2XAhbawvqp16bKPVioAVNg==
Access-Control-Allow-Origin: https://www.genedock.com

Body:

{
  "workflows": [
    {
      "status": "checked",
      "configs": {
        "nodelist": [
          {
            "alias": "load reference genome sequences",
            "node_id": "randomcode0_loaddata",
            "app_id": "55128c58f6f4067d63b956b5",
            "outputs": {
              "data": {
                "enid": "refgenome_enid"
              }
            }
          },
          {
            "inputs": {
              "database": [
                {
                  "enid": "refgenome_enid"
                }
              ]
            },
            "parameters": {
              "block_size": {
                "variable": false,
                "value": 10000000
              },
              "algorithm_type": {
                "variable": true,
                "value": "bwtsw"
              },
              "six": {
                "variable": false,
                "value": false
              }
            },
            "outputs": {
              "index": [
                {
                  "enid": "index_enid"
                }
              ]
            },
            "app_id": "55da95ae5346806cd6e1f25e",
            "alias": "bwa index",
            "node_id": "randomcode1_bwaindex"
          },
          {
            "alias": "index file for reference genome sequences",
            "node_id": "randomcode2_storedata",
            "app_id": "55128c94f6f4067d63b956b6",
            "parameters": {
              "description": {
                "variable": true
              },
              "name": {
                "variable": true
              }
            },
            "inputs": {
              "data": {
                "enid": "index_enid"
              }
            }
          }
        ]
      },
      "version": 3,
      "description": "BWA是为短序列比对参考序列而开发的软件。此Workflow以参考基因组fasta序列为输入，通过index建立参考基因组的索引并输出，是BWA比对的前置步骤。\n"
    }
  ]
}

DeleteWorkflow

DeleteWorkflow接口删除当前project下指定的workflow及其配置。

请求语法

DELETE /accounts/<account_name>/projects/<project_name>/workflows/<workflow_name>/?workflow_version=<workflow_version> HTTP/1.1

Header:

Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Region Endpoint>
Content-Length: <Content Length>
Content-Type: application/json
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

请求参数

属性名称	类型	是否必须	描述
workflow_version	int	是	workflow的版本号

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

请求成功返回200

错误码

除了返回GeneDock API的通用错误码，还可能返回如下特有错误码

HTTP状态码	错误码	错误信息	描述
400	InvalidParameter	Delete workflow failed, since {reason}.	删除工作流出错，原因是{reason}。

请求示例

DELETE /accounts/genedock/projects/default/workflows/BWA-MEM/?workflow_version=1 HTTP/1.1

Header:

Authorization: GeneDock oHFcHbORoZCavj7GPtytUg==:pWsK9iuFUapeWXy3FC1bB6SbGGA=
Date: Tur, 7 Apr 2016 02:04:34 GMT
Host: cn-shenzhen-api.genedock.com
Content-Length: 27
Content-Type: application/json
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

响应示例

HTTP/1.1 200 OK

Header：

Date: Tur, 7 Apr 2016 02:04:34 GMT
Content-Length: 0
x-gd-requestid: 573c1981c3666e19ea024349
Connection: close
Server: nginx/1.4.6

ListWorkflow

ListWorkflow接口列出当前Project下所有可编辑的Workflow。

请求语法

GET /accounts/<account_name>/projects/<project_name>/workflows/ HTTP/1.1

Header:

Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Region Endpoint>
Content-Length: <Content Length>
Content-Type: application/json
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

请求参数

暂无。

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

ListWorkflow请求成功，其响应的Body会包括当前project下所有符合请求条件的Workflow列表，具体格式如下：

属性名称	类型	描述
workflow_url	string	符合条件的workflow的url
workflow_name	string	符合条件的workflow名称
workflow_version	int	符合条件的workflow版本
workflow_id	string	符合条件的workflow id
description	string	符合条件的workflow描述信息
status	string	符合条件的workflow状态
authorized_methods	list	对workflow的url可以执行的请求

错误码

除了返回GeneDock API的通用错误码，还可能返回以下特有错误码。

HTTP状态码	错误码	错误信息	描述
400	InvalidParameter	List workflow failed, since {reason}.	列出工作流失败，原因是{reason}。
404	WorkflowNotExists	List workflow cannot find anything.	找不到任何可以列出的工作流。

请求示例

GET /accounts/genedock/projects/default/workflows/ HTTP/1.1

Header:

Authorization: GeneDock oHFcHbORoZCavj7GPtytUg==:fRxi7bDRo2RRye4+O5dzk45giCw=
Date: Tur, 7 Apr 2016 02:04:34 GMT
Host: cn-shenzhen-api.genedock.com
Content-Length: 0
Content-Type: application/json
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

返回示例

HTTP/1.1 200 OK

Header：

Date: Tur, 7 Apr 2016 02:04:34 GMT
Content-Length: 1195
x-gd-requestid: 573c1981c3666e19ea024349
Connection: close
Content-Type: application/json;charset=utf-8
Server: nginx/1.4.6

Body：
{
  "workflow_url": "https://cn-shenzhen-api.genedock.com/accounts/genedock/projects/default/workflows/",
  "items": [
    [
      {
        "status": "checked",
        "description": "Genome Analysis Toolkit Demo",
        "workflow_name": "GATK",
        "workflow_url": "https://cn-shenzhen-api.genedock.com/accounts/genedock/projects/default/workflows/GATK/",
        "workflow_id": "56dfdc28e77189001247c3c6",
        "workflow_version": 1,
        "authorized_methods": ["GET", "PUT", "DELETE"]
      },
      {
        "status": "checked",
        "description": "Genome Analysis Toolkit",
        "workflow_name": "GATK",
        "workflow_url": "https://cn-shenzhen-api.genedock.com/accounts/genedock/projects/default/workflows/GATK/",
        "workflow_id": "57398dfbf28bec00485333a7",
        "workflow_version": 2,
        "authorized_methods": ["GET", "PUT", "DELETE"]
      }
    ],
    [
      {
        "status": "unchecked",
        "description": "Splitted BLAST",
        "workflow_name": "blast_split",
        "workflow_url": "https://cn-shenzhen-api.genedock.com/accounts/genedock/projects/default/workflows/blast_split/",
        "workflow_id": "56dfdc4fe77989001547c3c8",
        "workflow_version": 2,
        "authorized_methods": ["GET", "PUT"]
      }
    ]
  ]
}

GetExecutableWorkflow

GetExecutableWorkflow接口返回当前project下指定的workflow的参数模版。

请求语法

GET /accounts/<account_name>/projects/<project_name>/executable-workflows/<workflow_name>/?workflow_version=<workflow_version> HTTP/1.1

Header:

Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Region Endpoint>
Content-Length: <Content Length>
Content-Type: application/json
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

请求参数

属性名称	类型	是否必须	描述
workflow_version	int	是	workflow的版本号

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

若请求成功，HTTP状态码返回200，并且响应的Body中会返回指定workflow的参数模板。

错误码

除了返回GeneDock API的通用错误码，还可能返回如下特有错误码

HTTP状态码	错误码	错误信息	描述
400	InvalidParameter	Get executable workflow failed, since {reason}.	获取可运行的工作流出错，原因是{reason}。

请求示例

GET /accounts/genedock/projects/default/executable-workflows/BWA-index/?workflow_version=3 HTTP/1.1

Header:

Authorization: GeneDock oHFcHbORoZCavj7GPtytUg==:pWsK9iuFUapeWXy3FC1bB6SbGGA=
Date: Thu, 01 Sep 2016 08:06:35 GMT
Host: cn-shenzhen-api.genedock.com
Content-Type: application/json; charset=UTF-8
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

响应示例

HTTP/1.1 200 OK

Header:

Server: nginx/1.1.19
Date: Thu, 01 Sep 2016 08:51:31 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 1473
Connection: keep-alive
x-gd-requestid: 57c7ec13671856001f7d8231
Content-MD5: 5VOXzGgDU3rs+vWADkSEOw==
Access-Control-Allow-Origin: https://www.genedock.com

Body:

{
  "parameter": {
    "Inputs": {
      "randomcode0_loaddata": {
        "category": "loaddata",
        "minitems": 1,
        "type": "file",
        "required": true,
        "alias": "load reference genome sequences",
        "maxitems": 1,
        "formats": [
          "fa",
          "fasta"
        ],
        "data": [
          {
            "property": {
              "block_file": {
                "block_name": null,
                "split_format": "default",
                "is_block": false
              }
            },
            "name": "/public/ucsc.hg19.fasta",
            "enid": null
          }
        ]
      }
    },
    "description": "<Please input the task's description in here>",
    "Parameters": {
      "randomcode1_bwaindex": {
        "alias": "bwa index",
        "parameters": {
          "block_size": {
            "variable": false,
            "required": false,
            "type": "number",
            "value": 10000000,
            "hint": ""
          },
          "algorithm_type": {
            "variable": true,
            "required": false,
            "type": "string",
            "value": "bwtsw",
            "hint": ""
          },
          "six": {
            "variable": false,
            "required": false,
            "type": "flag",
            "value": false,
            "hint": ""
          }
        }
      }
    },
    "Outputs": {
      "randomcode2_storedata": {
        "minitems": 1,
        "data": [
          {
            "property": {
              "block_file": {
                "block_name": null,
                "split_format": "default",
                "is_block": false
              }
            },
            "description": "<Please input the description of the output data in here>",
            "name": "<Please input the name of the output data in here>"
          }
        ],
        "alias": "index file for reference genome sequences",
        "maxitems": 1,
        "formats": [
          "tgz"
        ],
        "type": "file"
      }
    },
    "Property": {
      "water_mark": {
        "style": null,
        "required": true
      },
      "CDN": {
        "required": true
      },
      "reference_task": [
        {
          "id": "<Please input the reference task's id>"
        }
      ]
    },
    "Conditions": {
      "schedule": ""
    },
    "name": "<Please input the task's name in here>"
  }
}

ListExecutableWorkflow

ListExecutableWorkflow接口列出当前Project下所有可运行的Workflow。

请求语法

GET /accounts/<account_name>/projects/<project_name>/executable-workflows/ HTTP/1.1

Header:

Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Region Endpoint>
Content-Length: <Content Length>
Content-Type: application/json
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

请求参数

暂无。

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

ListExecutableWorkflow请求成功，其响应的Body会包括当前project下所有符合请求条件的Workflow列表，具体格式如下：

属性名称	类型	描述
workflow_url	string	符合条件的workflow的url
workflow_name	string	符合条件的workflow名称
workflow_version	int	符合条件的workflow版本
workflow_id	string	符合条件的workflow id
description	string	符合条件的workflow描述信息
status	string	符合条件的workflow状态

错误码

除了返回GeneDock API的通用错误码，还可能返回以下特有错误码。

HTTP状态码	错误码	错误信息	描述
400	InvalidParameter	List executable workflow failed, since {reason}.	列出可运行的工作流失败，原因是{reason}。
404	WorkflowNotExists	List executable workflow cannot find anything.	找不到任何可以列出的可执行工作流。

请求示例

GET /accounts/genedock/projects/default/executable-workflows/ HTTP/1.1

Header:

Authorization: GeneDock oHFcHbORoZCavj7GPtytUg==:fRxi7bDRo2RRye4+O5dzk45giCw=
Date: Tur, 7 Apr 2016 02:04:34 GMT
Host: cn-shenzhen-api.genedock.com
Content-Length: 0
Content-Type: application/json
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

返回示例

HTTP/1.1 200 OK

Header：

Date: Tur, 7 Apr 2016 02:04:34 GMT
Content-Length: 1195
x-gd-requestid: 573c1981c3666e19ea024349
Connection: close
Content-Type: application/json;charset=utf-8
Server: nginx/1.4.6

Body：
{
  "workflow_url": "https://cn-shenzhen-api.genedock.com/accounts/genedock/projects/default/executable-workflows/",
  "items": [
    [
      {
        "status": "checked",
        "description": "Genome Analysis Toolkit Demo",
        "workflow_name": "GATK",
        "workflow_url": "https://cn-shenzhen-api.genedock.com/accounts/genedock/projects/default/executable-workflows/GATK/",
        "workflow_id": "56dfdc28e77189001247c3c6",
        "workflow_version": 1
      },
      {
        "status": "checked",
        "description": "Genome Analysis Toolkit",
        "workflow_name": "GATK",
        "workflow_url": "https://cn-shenzhen-api.genedock.com/accounts/genedock/projects/default/executable-workflows/GATK/",
        "workflow_id": "57398dfbf28bec00485333a7",
        "workflow_version": 2
      }
    ],
    [
      {
        "status": "unchecked",
        "description": "Splitted BLAST",
        "workflow_name": "blast_split",
        "workflow_url": "https://cn-shenzhen-api.genedock.com/accounts/genedock/projects/default/executable-workflows/blast_split/",
        "workflow_id": "56dfdc4fe77989001547c3c8",
        "workflow_version": 2
       }
    ]
  ]
}

ActivateWorkflow

运行指定工作流，并返回task_id，task_name。
备注: 指定的输出文件如果已存在, 运行Task时会覆盖已存在的输出文件。

请求语法

POST /accounts/<account_name>/projects/<project_name>/tasks/ HTTP/1.1

Header:

Authorization: <AuthorizationString>
Content-Type: application/json
Content-Length: <Content Length>
Date: <GMT Date>
Host: <Region Endpoint>
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1

Body:
{
    "worklfow_name" : <WorkflowName>,
    "workflow_version": <WorkflowVersion>,
    "task_name": <TaskName>,
    "parameters": <WorkflowParameters>
}

请求参数

属性名称	类型	是否必须	描述
workflow_name	string	是	Workflow名称
workflow_version	int	是	指定Workflow版本号
workflow_owner	string	否	如果工作流属于当前访问账号，此参数则不需要指定。如果工作流不属于当前账号，需要使用此参数指明工作流所属的账号名。
parameters	json	是	Workflow运行所需要的参数配置
task_name	string	否	用户在运行Workflow时指定的Task名称。Task的名称，在project下必须唯一。3~128个字符，包含字母、数字、短横线”-“、下划线”_“，必须以字母开头。如果用户不指定，则默认由系统生成。不支持中文Task名称。

请求头

无特定请求头，关于GeneDock API公共请求头请参照公共请求头。

响应头

无特定响应头，关于GeneDock API公共响应头请参照公共响应头。

响应元素

ActiveWorkflow请求成功，其响应的Body会包含task_id 和 task_name，具体格式如下：

属性名称	类型	描述
task_id	string	Task的唯一标识
task_name	string	用户在运行Workflow时指定的Task名称。

错误码

除了返回GeneDock API的通用错误码，还可能返回如下特有错误码:

HTTP状态码	错误码	错误信息	描述
400	InvalidParameter	Invalid parameter	请求参数不正确
404	TaskNotFound	Activate workflow failed	任务创建失败

请求示例

POST /accounts/genedock/projects/default/tasks/ HTTP/1.1

Header:

Authorization: GeneDock Okigx7vHAjpcQUqj+dhPXg==:CDtFE8yfEbBJEF2Nw9ezf5f7uRI=
Content-Type: application/json
Content-Length: 1527
Date: Thu, 19 May 2016 03:32:27 GMT
Host: cn-shenzhen-api.genedock.com
x-gd-apiversion: 1.0
x-gd-signaturemethod: hmac-sha1-v1
User-Agent: genedock-python-sdk-v-0.1.0

Body:
{
    "workflow_name": "bam_stats",
    "workflow_version": 1,
    "task_name": "test_bam_stats",
    "parameters": {
        "Inputs": {
            "loaddataNode1": {
                "category": "loaddata",
                "minitems": 1,
                "type": "file",
                "required": true,
                "alias": "bam",
                "maxitems": 1,
                "formats": [
                    "bam",
                    "sam"
                ],
                "data": [
                    {
                        "property": {
                            "block_file": {
                                "block_name": null,
                                "split_format": "default",
                                "is_block": false
                            }
                        },
                        "name": "WGS_mapping_2016_04_21_21_14_48/bam18_0.bam",
                        "enid": "5718d2601315e00018dfcbe7"
                    }
                ]
            }
        },
        "name": null,
        "Parameters": {
            "plot_bamstatsNode3": {
                "alias": "plot-bamstats",
                "parameters": {}
            },
            "samtools_stats_1_3_5_g664cc5fNode2": {
                "alias": "samtools stats",
                "parameters": {
                    "required_flag": {
                        "variable": false,
                        "required": false,
                        "type": "string",
                        "value": " ",
                        "hint": "Required flag, 0 for unset."
                    },
                    "remove_dups": {
                        "variable": false,
                        "required": false,
                        "type": "flag",
                        "value": false,
                        "hint": "Exclude from statistics reads marked as duplicates"
                    },
                    "filtering_flag": {
                        "variable": false,
                        "required": false,
                        "type": "string",
                        "value": " ",
                        "hint": "Filtering flag, 0 for unset."
                    }
                }
            }
        },
        "Outputs": {
            "storedataNode4": {
                "alias": "bc plot",
                "maxitems": 1,
                "formats": [
                    "tgz"
                ],
                "minitems": 1,
                "type": "file",
                "data": [
                    {
                        "property": {
                            "block_file": {
                                "block_name": null,
                                "split_format": "default",
                                "is_block": false
                            }
                        },
                        "name": "test",
                        "description": "the bwa stat output"
                    }
                ]
            }
        },
        "Property": {
            "water_mark": {
                "style": null,
                "required": true
            },
            "CDN": {
                "required": true
            },
            "reference_task": [
                {
                    "id": null
                }
            ]
        },
        "Conditions": {
            "schedule": ""
        },
        "description": "test the bwa stat workflow"
    }
}

响应示例

HTTP/1.1 200 OK

Header：

Content-Length: 64
x-gd-requestid: 573d32d11315e00014e1b99e
Server: gunicorn/19.1.1
Connection: keep-alive
Date: Thu, 19 May 2016 03:28:18 GMT
Content-Type: application/json;charset=utf-8

Body:
{
    "task_id": "573c2237c3666e1a2f033226",
    "task_name": "test_bwa_stat"
}